<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpIterationOutput.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpIterationOutput_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">IpIterationOutput.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="IpIterationOutput_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (C) 2004, 2011 International Business Machines and others.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// Authors:  Andreas Waechter, Carl Laird       IBM    2004-09-27</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef __IPITERATIONOUTPUT_HPP__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define __IPITERATIONOUTPUT_HPP__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="IpIpoptNLP_8hpp.html">IpIpoptNLP.hpp</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;<a class="code" href="IpIpoptData_8hpp.html">IpIpoptData.hpp</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;<a class="code" href="IpIpoptCalculatedQuantities_8hpp.html">IpIpoptCalculatedQuantities.hpp</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>{</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html">   20</a></span><span class="keyword">class </span><a class="code hl_define" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> <a class="code hl_class" href="classIpopt_1_1IterationOutput.html">IterationOutput</a>: <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1AlgorithmStrategyObject.html">AlgorithmStrategyObject</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#acb214e6e4375b916336e9f76a0548346">   26</a></span>   <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#acb214e6e4375b916336e9f76a0548346">IterationOutput</a>()</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>   { }</div>
</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="}">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#a31a0902c725430cc5315bffe6a8e7f77">   30</a></span>   <span class="keyword">virtual</span> <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#a31a0902c725430cc5315bffe6a8e7f77">~IterationOutput</a>()</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>   { }</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#abd2bd5bca18a9c5838ebfc91292e0515">   34</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#abd2bd5bca18a9c5838ebfc91292e0515">InitializeImpl</a>(</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp; options,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>      <span class="keyword">const</span> std::string&amp; prefix</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>   ) = 0;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#a824ebb640fef9279cf80e3fa8a43ae2f">   44</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#a824ebb640fef9279cf80e3fa8a43ae2f">WriteOutput</a>() = 0;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">protected</span>:</div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="};">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#aadaec4d7ec1d3a12338b05939907a19f">   48</a></span>   <span class="keyword">enum</span> <a class="code hl_enumeration" href="classIpopt_1_1IterationOutput.html#aadaec4d7ec1d3a12338b05939907a19f">InfPrOutput</a></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>   {</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#aadaec4d7ec1d3a12338b05939907a19faa2d8e9e245b10644073ebd77e07cf438">   50</a></span>      INTERNAL = 0,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>      ORIGINAL</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#aadaec4d7ec1d3a12338b05939907a19fac18e496b8fc16c55086b2addf91d3848">   52</a></span>   };</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#ad2072815388e37c4c0e3e1e49339f090">   65</a></span>   <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#ad2072815388e37c4c0e3e1e49339f090">IterationOutput</a>(</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1IterationOutput.html">IterationOutput</a>&amp;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>   );</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classIpopt_1_1IterationOutput.html#a3bc81ab610ef4990eec59087e6e09eb4">   69</a></span>   <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1IterationOutput.html#a3bc81ab610ef4990eec59087e6e09eb4">operator=</a>(</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1IterationOutput.html">IterationOutput</a>&amp;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>   );</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>};</div>
</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aIpAlgStrategy_8hpp_html"><div class="ttname"><a href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a></div></div>
<div class="ttc" id="aIpIpoptCalculatedQuantities_8hpp_html"><div class="ttname"><a href="IpIpoptCalculatedQuantities_8hpp.html">IpIpoptCalculatedQuantities.hpp</a></div></div>
<div class="ttc" id="aIpIpoptData_8hpp_html"><div class="ttname"><a href="IpIpoptData_8hpp.html">IpIpoptData.hpp</a></div></div>
<div class="ttc" id="aIpIpoptNLP_8hpp_html"><div class="ttname"><a href="IpIpoptNLP_8hpp.html">IpIpoptNLP.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1AlgorithmStrategyObject_html"><div class="ttname"><a href="classIpopt_1_1AlgorithmStrategyObject.html">Ipopt::AlgorithmStrategyObject</a></div><div class="ttdoc">This is the base class for all algorithm strategy objects.</div><div class="ttdef"><b>Definition</b> <a href="IpAlgStrategy_8hpp_source.html#l00034">IpAlgStrategy.hpp:35</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html">Ipopt::IterationOutput</a></div><div class="ttdoc">Base class for objects that do the output summary per iteration.</div><div class="ttdef"><b>Definition</b> <a href="IpIterationOutput_8hpp_source.html#l00020">IpIterationOutput.hpp:21</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_a31a0902c725430cc5315bffe6a8e7f77"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#a31a0902c725430cc5315bffe6a8e7f77">Ipopt::IterationOutput::~IterationOutput</a></div><div class="ttdeci">virtual ~IterationOutput()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> <a href="IpIterationOutput_8hpp_source.html#l00030">IpIterationOutput.hpp:30</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_a3bc81ab610ef4990eec59087e6e09eb4"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#a3bc81ab610ef4990eec59087e6e09eb4">Ipopt::IterationOutput::operator=</a></div><div class="ttdeci">void operator=(const IterationOutput &amp;)</div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_a824ebb640fef9279cf80e3fa8a43ae2f"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#a824ebb640fef9279cf80e3fa8a43ae2f">Ipopt::IterationOutput::WriteOutput</a></div><div class="ttdeci">virtual void WriteOutput()=0</div><div class="ttdoc">Method to do all the summary output per iteration.</div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_aadaec4d7ec1d3a12338b05939907a19f"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#aadaec4d7ec1d3a12338b05939907a19f">Ipopt::IterationOutput::InfPrOutput</a></div><div class="ttdeci">InfPrOutput</div><div class="ttdoc">enumeration for different inf_pr output options</div><div class="ttdef"><b>Definition</b> <a href="IpIterationOutput_8hpp_source.html#l00048">IpIterationOutput.hpp:49</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_abd2bd5bca18a9c5838ebfc91292e0515"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#abd2bd5bca18a9c5838ebfc91292e0515">Ipopt::IterationOutput::InitializeImpl</a></div><div class="ttdeci">virtual bool InitializeImpl(const OptionsList &amp;options, const std::string &amp;prefix)=0</div><div class="ttdoc">Implementation of the initialization method that has to be overloaded by for each derived class.</div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_acb214e6e4375b916336e9f76a0548346"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#acb214e6e4375b916336e9f76a0548346">Ipopt::IterationOutput::IterationOutput</a></div><div class="ttdeci">IterationOutput()</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition</b> <a href="IpIterationOutput_8hpp_source.html#l00026">IpIterationOutput.hpp:26</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IterationOutput_html_ad2072815388e37c4c0e3e1e49339f090"><div class="ttname"><a href="classIpopt_1_1IterationOutput.html#ad2072815388e37c4c0e3e1e49339f090">Ipopt::IterationOutput::IterationOutput</a></div><div class="ttdeci">IterationOutput(const IterationOutput &amp;)</div><div class="ttdoc">Copy Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1OptionsList_html"><div class="ttname"><a href="classIpopt_1_1OptionsList.html">Ipopt::OptionsList</a></div><div class="ttdoc">This class stores a list of user set options.</div><div class="ttdef"><b>Definition</b> <a href="IpOptionsList_8hpp_source.html#l00032">IpOptionsList.hpp:33</a></div></div>
<div class="ttc" id="aconfig__default_8h_html_a58bb5c104ee5ff44b7175fc992d89b0b"><div class="ttname"><a href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a></div><div class="ttdeci">#define IPOPTLIB_EXPORT</div><div class="ttdef"><b>Definition</b> <a href="config__default_8h_source.html#l00010">config_default.h:10</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
